Skip to content

Bump API schema to ddda9506#16897

Open
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-ddda9506
Open

Bump API schema to ddda9506#16897
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-ddda9506

Conversation

@getsantry
Copy link
Contributor

@getsantry getsantry bot commented Mar 11, 2026

No description provided.

@vercel
Copy link

vercel bot commented Mar 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Mar 11, 2026 7:57pm
sentry-docs Ready Ready Preview, Comment Mar 11, 2026 7:57pm

Request Review

// SENTRY_API_SCHEMA_SHA is used in the sentry-docs GHA workflow in getsentry/sentry-api-schema.
// DO NOT change variable name unless you change it in the sentry-docs GHA workflow in getsentry/sentry-api-schema.
const SENTRY_API_SCHEMA_SHA = '0583755a815d16d432791204c3547c39483345d6';
const SENTRY_API_SCHEMA_SHA = 'ddda95066e1e5469719906060605f9fec04010e5';
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The code may crash in apiCategoriesUncached when an API uses a tag not defined in data.tags, leading to an attempt to access a property on undefined.
Severity: CRITICAL

Suggested Fix

Before pushing to the apis array within the apiData.tags.forEach loop, add a check to verify that categoryMap[tag] exists. If it does not, either skip the tag or log a warning to prevent the build from crashing.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: src/build/resolveOpenAPI.ts#L11

Potential issue: In the `apiCategoriesUncached` function, the code populates a
`categoryMap` using tags from `data.tags`. It then iterates through API endpoints and
their associated tags. If an API endpoint uses a tag that is not present in the initial
`data.tags` list, the code will attempt to access the `apis` property on an `undefined`
value (`categoryMap[tag]`). This will throw a `Cannot read properties of undefined
(reading 'apis')` error, causing the documentation build process to crash.

Did we get this right? 👍 / 👎 to inform future reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants